home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / text / hyper / AmigaGuPref.lha / AGPrefs / AGPrefs.Doc next >
Text File  |  1994-12-03  |  6KB  |  210 lines
  1.               Amigaguide preferences - Lee Kindness.
  2.               ======================================
  3.  
  4. Introduction
  5. ============
  6.     Amigaguide has various preference options. However no preference editor
  7. is supplied to alter them, now you can. This program requires OS36+ (WB2)
  8. if you do not have this then lookup the AmigaGuide documentation to find 
  9. out how you can change these preferences. AmigaGuide prefs is identical
  10. to the C= preference editors, it is therefore easy to use. For more 
  11. information on any of the preference options look at the AmigaGuide 
  12. documentation in the "Preference" section.
  13.     These preferences are not respected by Multiview in Release 3. I would
  14. recomend that you use Amigaguide (copy V34 of Amigaguide to your LIBS: from
  15. the Amigaguide distribution). In doing so online help will abide to your
  16. preferences.
  17.  
  18. Installation
  19. ============
  20.     The included install script will copy the program to SYS:Prefs. The C= 
  21. installer is required in your path.
  22.  
  23. Usage
  24. =====
  25.     Double click from workbench or "SYS:Prefs/Amigaguide" from the Shell.
  26. A number of arguments are supported, from the Shell the template is
  27.  
  28.     FROM,EDIT/S,USE/S,SAVE/S,PUBSCREEN/K:
  29.  
  30. FROM
  31.     name of a directory specifying where to load the preference files from,
  32.     defaults to "ENV:AmigaGuide/".
  33.  
  34. EDIT
  35.     No purpose.
  36.  
  37. USE
  38.     Don't open the window and save the preference files to 
  39.     "ENV:AmigaGuide/". The settings from the specified file will be put
  40.     effect.
  41.  
  42. SAVE
  43.     Don't open the window and save the preference files to 
  44.     "ENVARC:AmigaGuide/". Settings will be put into effect and will also
  45.     be in use after a reset.
  46.  
  47. PUBSCREEN
  48.     Name of the public screen to open the window on.
  49.  
  50. The following Workbench icon tooltypes are supported, their meaning is as
  51. above :
  52.     FROM=<filename>
  53.     EDIT
  54.     USE
  55.     SAVE
  56.     ACTION=<EDIT|USE|SAVE>
  57.     PUBSCREEN=<screenname>  
  58.  
  59. For more information on the above options see your workbench 
  60. documentation on preference editors.
  61.  
  62. THE WINDOW
  63. ----------
  64.  
  65.     A window appears with three sets of gadgets. These gadgets are used to
  66. change various preference settings of AmigaGuide. The gadgets:
  67.  
  68. "Path"
  69.     This listview shows the list of directories that AmigaGuide will search
  70. through in attempts to find files. A new path may be added using the "New"
  71. button. You can edit this path by either changing the text in the string
  72. gadget below the list or selecting the "Directory" gadget, this will cause a
  73. requester to appear so that you can pick a directory from it. A path can be
  74. removed using the "Remove" button.
  75.  
  76. "Text"
  77.     This cycle gadget lets you pick what style the node points in an 
  78. Amigaguide document appear as. You can choose from "Button", "Highlight", 
  79. "Underline", "Bold" or "Italic".
  80.  
  81. "Sample"
  82.     How a guide file would look using the current settings.
  83.  
  84. "Pens"
  85.     This listview lets you select what colour certain features in an 
  86. AmigaGuide document appear in. Select an item in the list view and then 
  87. choose the colour you wish in the palette gadget below. The items in the 
  88. list are self documenting.
  89.  
  90. "Save"
  91.     This button saves the current preferences and exits.
  92.  
  93. "Use" 
  94.     This button exits with the current preferences in effect.
  95.  
  96. "Cancel"
  97.     This button exits with no change to the preferences.
  98.  
  99. The menu items do the following:
  100.  
  101. "Open..."
  102.     Lets you pick a directory from which preferences will be loaded in from
  103.  
  104. "Save As..."
  105.     Lets you pick a file to which the preferences will be saved.
  106.  
  107. "Quit"
  108.     As "Cancel".
  109.  
  110. "Reset To Defaults"
  111.     Changes the preferences to their default values.
  112.  
  113. "Last Saved"
  114.     Restores the last saved preferences.
  115.  
  116. "Restore"
  117.     Restores the preferences in use before the program was launched. 
  118.  
  119. "Presets"
  120.     A submenu of predefined pen and/or text settings. For want of better names,
  121. these items have fairly wacky names. For example "Skerza" (old Norse for
  122. scary), "Strappado" (a form of torture where a person is tied to a rope and
  123. then let to fall half the length of the rope), "Baked Beans", "heterophyte"
  124. (a parasite) and of course the reoccuring "Wangi".
  125.  
  126. "Create Icons?"
  127.     If checked then icons will be created via the "Save As..." menuitem. 
  128. When these icons are doubleclicked their contents will be used.
  129.  
  130.  
  131. Contact
  132. =======   
  133.     Lee Kindness
  134.     8 Craigmarn Road
  135.     Old Portlethen Village
  136.     ABERDEEN
  137.     AB1 4QR
  138.     SCOTLAND.
  139.  
  140. Any gifts, cash and even bug reports are greatly appreciated ¿-). Sending
  141. me £3 (or equivalent of £5 plus) will get you the the latest verson of this
  142. program plus a heap more useful programs.
  143.  
  144. History
  145. =======
  146.  
  147. AmigaGuide prefs was written using HighSpeed Pascal on an A1200. 
  148. AGPrefs was tested on:
  149.     A1200, 120MB HD, 2+4 MB RAM, 68030 CPU running Enforcer
  150.     A600 FD
  151.  
  152.     V36.23    : 12.08.94
  153.                 + Initial Version
  154.  
  155.     V36.31    : 14.08.94
  156.                 - did not have enough stack, therefore program was vegging in 
  157.                   some procedures (normally "Directory" function).
  158.                 - Fixed install script still had references to "Bush" (just 
  159.                   changed a couple of bits from the bush script for AGP script)
  160.  
  161.     V36.32    : 05.09.94
  162.                 - Fixed Enforcer hits.
  163.  
  164.     V36.36    : 19.09.94
  165.                 - Palette gadget now bigger so that it is the same height as the
  166.                   path gadgets.
  167.  
  168.     V36.40    : 21.09.94
  169.                 - Can now set "Pens" preferences to more than 8 colours.
  170.                 - Palette gadget now shows 207 (256 pre V39) colours (Amigaguide 
  171.                   maximum) rather than 8
  172.  
  173.     V26.44    : 22.09.94
  174.                 - Palette gadget now shows the maximum number of colours 
  175.                   available on the current screen or 207 if 256 or more are
  176.                   available.
  177.  
  178.     V36.66    : 23.09.94
  179.                 - "Open" and "Save As..." menu items added.
  180.                 - Standard preference options added (tooltypes/arguments)
  181.  
  182.     V36.69    : 02.10.94
  183.                 - Palette gadget now only showns the amount of colours available
  184.                   on the screen it is on, up to a max of 207.
  185.  
  186.     V36.89    : 20.10.94
  187.                 - Added "Preset" submenu.
  188.  
  189.     V36.101    : 27.10.94
  190.                 - Added "Highlight" option to the "Text" cycle gadget. This is a
  191.                   valid Amigaguide option but when set Amigaguide text is 
  192.                   not "Highlighted" its just plain without a box round it?
  193.  
  194.     V36.123    : 01.11.94
  195.                 - Added the "Sample" display.
  196.  
  197.     V36.132    : 06.11.94
  198.                 - Presets handled better internally, reducion in code size as a
  199.                   result, plus easier expansion capibilities... ooh!
  200.                   
  201.     V36.140  : 07.11.94
  202.                 - More presets added.
  203.                 - "Save As..." now saves in an internal format.
  204.                 - Full WB preference editor compatibility, now saves presets which
  205.                   can be double clicked on to use their values.
  206.                   
  207.     V36.144    : 03.12.94
  208.                 - Added "MagicWB" preset.
  209.  
  210. -EOF LSK _\\//